API Documentation
Public Member Functions | List of all members
nkAstraeus::Engine Class Referencefinal

The main entry point for nkAstraeus engine. More...

Inheritance diagram for nkAstraeus::Engine:

Public Member Functions

bool initialize () const
 
void shutdown () const
 

Detailed Description

The main entry point for nkAstraeus engine.

It allows to drive the initialization and shutdown of the engine. This will initialize all the sub component at once. If need be, all sub components can be initialized individually. This can be useful, for instance, to initialize the scripting environment and access wrapping alone.

Member Function Documentation

◆ initialize()

bool nkAstraeus::Engine::initialize ( ) const

Initializes the whole nkAstraeus component. This will ensure all sub components of the engine are thoroughly initialized.

Returns
Whether the initialization went well (true) or not (false).
Remarks
If the initialization process fails, it will be necessary to check the log and fix the problem, as the engine will be unusable.

◆ shutdown()

void nkAstraeus::Engine::shutdown ( ) const

Shuts down the engine and clear all memory of the component, and its sub parts.


The documentation for this class was generated from the following file: